/*******************************************************************************
 * Copyright 2017 Capital One Services, LLC and Bitwise, Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License
 *******************************************************************************/
package hydrograph.engine.core.component.generator.base;

import hydrograph.engine.core.component.entity.base.AssemblyEntityBase;
import hydrograph.engine.jaxb.commontypes.TypeBaseComponent;

import java.io.Serializable;
/**
 * The Interface GeneratorBase.
 *
 * @author Bitwise
 */
public interface GeneratorBase extends Serializable{

	/**
	 * Casts the {@link TypeBaseComponent} object to the object of jaxb
	 * component class specific to the assembly being generated
	 * 
	 * @param baseComponent
	 *            the {@link TypeBaseComponent} object to cast to specific jaxb
	 *            component object
	 */
	public  void castComponentFromBase(TypeBaseComponent baseComponent);

	/**
	 * Creates an object of the entity class
	 */
	public  void createEntity();

	/**
	 * Initializes the entity object
	 */
	public  void initializeEntity();
	
	/**
	 * Returns the entity object
	 */
	public AssemblyEntityBase getEntity();
}
